.\" Man page generated from reStructuredText.
.
.TH MISSPELLINGS 1 "" "" "Utilities"
.SH NAME
misspellings \- misspellings - spell checker for code
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBmisspellings\fP misspellings [\fIoptions\fP] [\fIfiles\fP]
.sp
Usage: misspellings [\-f file_list] [files]
.sp
Checks files for common spelling mistakes.
.INDENT 0.0
.TP
.B Options:
.INDENT 7.0
.TP
.B \-v,  \-\-version
Show the version number and exit.
.TP
.B \-h,  \-\-help
Show this help message and exit.
.TP
.BI \-f \ file
File containing list of files to check.
.TP
.BI \-m \ file
File containing list of misspelled words & corrections.
.TP
.B \-d
Dump the list of misspelled words.
.TP
.B \-i
Interactively fix the file.
.TP
.BI \-s \ file
Create a shell script to interactively correct the files \-
script saved to the given file.
.UNINDENT
.sp
files: Zero or more files to check.
.UNINDENT
.SH DESCRIPTION
.sp
The \fBmisspellings\fP command provides a command line tool to spell
check code.
.sp
For basic usage, run with a list of files or use the \fB\-f\fP option
to specify a list of files to check. Use \fB\-f \-\fP to read a list
of files from stdin.
.sp
To simplify modifying code, use the \fB\-s\fP flag to generate a sed
script to change the code. Make sure the check the results, perhaps
using \fBdiff\fP.
.sp
Currently the tool only checks for common misspellings in English.
If you can come up with a list for a different language, use the
\fB\-m\fP option.
.SH BUGS
.sp
Quite possibly. Report them via the issue tracker at the project
website:
.sp
\fI\%https://github.com/lyda/misspell\-check/issues\fP
.SH SEE ALSO
.sp
\fI\%http://en.wikipedia.org/wiki/Wikipedia:Lists_of_common_misspellings\fP
.SH RESOURCES
.sp
Project website: \fI\%http://github.com/lyda/misspell\-check\fP
.SH COPYING
.sp
Copyright (C) 2012 Kevin Lyda.
Free use of this software is granted under the terms of the Apache
License.
.SH AUTHOR
Kevin Lyda <kevin@ie.suberic.net>
.\" Generated by docutils manpage writer.
.
